Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

core/connection: dont cancel transient disconnect timer with connecting status #404

Merged
merged 1 commit into from
Nov 27, 2024
Merged

core/connection: dont cancel transient disconnect timer with connecting status #404

merged 1 commit into from
Nov 27, 2024
+175 −66

Conversation

AndyTWF
Copy link
Collaborator

@AndyTWF AndyTWF commented Nov 14, 2024

Description

At the moment, if a connecting status is received during a transient disconnect timer, we cancel the timer.

This isn't really ideal - as it defeats the point of a transient disconnect timeout. Equally, we suppress the error that caused the state in the first place.

This change:

  • Will only cancel the transient disconnect timeout on a state that isn't connecting.
  • When the transient disconnect timeout timer expires, it will pass the current status, but with the error from the original state change.

Checklist

  • QA'd by the author.
  • Unit tests created (if applicable).
  • Integration tests created (if applicable).
  • Follow coding style guidelines found here.
  • TypeDoc updated (if applicable).
  • (Optional) Update documentation for new features.
  • Browser tests created (if applicable).
  • In repo demo app updated (if applicable).

Testing Instructions (Optional)

N/A

@AndyTWF AndyTWF requested a review from a team November 14, 2024 17:05
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Nov 14, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot temporarily deployed to staging/pull/404/typedoc November 14, 2024 17:06 Inactive
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 14, 2024 •
edited
Loading

Coverage Report

Status Category Percentage Covered / Total
🟢 Lines 93.34% (🎯 92%) 3099 / 3320
🟢 Statements 93.34% (🎯 92%) 3099 / 3320
🟢 Functions 95.16% (🎯 92%) 236 / 248
🟢 Branches 93.61% (🎯 93%) 821 / 877
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/core/connection.ts 97.84% 96.29% 100% 97.84% 173-174
Generated in workflow #1806 for commit 363742a by the Vitest Coverage Report Action

@AndyTWF AndyTWF force-pushed the connection-status-propagation branch from 95d9b03 to ee4dff3 Compare November 15, 2024 09:51
@github-actions github-actions bot temporarily deployed to staging/pull/404/typedoc November 15, 2024 09:52 Inactive
@AndyTWF AndyTWF marked this pull request as ready for review November 15, 2024 09:53
@AndyTWF AndyTWF requested review from a team, owenpearson and JoaoDiasAbly and removed request for a team November 21, 2024 11:38
owenpearson
owenpearson reviewed Nov 25, 2024
View reviewed changes
test/core/connection.test.ts Outdated Show resolved Hide resolved
test/core/connection.test.ts Outdated Show resolved Hide resolved
src/core/connection.ts Outdated Show resolved Hide resolved
src/core/connection.ts Outdated Show resolved Hide resolved
test/core/connection.test.ts Outdated Show resolved Hide resolved
@AndyTWF AndyTWF force-pushed the connection-status-propagation branch from ee4dff3 to f58e57e Compare November 25, 2024 11:48
@github-actions github-actions bot temporarily deployed to staging/pull/404/typedoc November 25, 2024 11:49 Inactive
owenpearson
owenpearson approved these changes Nov 25, 2024
View reviewed changes
Copy link
Member

@owenpearson owenpearson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@AndyTWF AndyTWF force-pushed the connection-status-propagation branch from f58e57e to 0a90909 Compare November 26, 2024 15:05
@github-actions github-actions bot temporarily deployed to staging/pull/404/typedoc November 26, 2024 15:05 Inactive
@AndyTWF
core/connection: dont cancel transient disconnect timer with connecti…
363742a 
…ng status

At the moment, if a connecting status is received during a transient disconnect timer, we cancel the timer.

This isn't really ideal - as it defeats the point of a transient disconnect timeout. Equally, we suppress the error
that caused the state in the first place.

This change:

- Will only cancel the transient disconnect timeout on a state that isn't connecting.
- When the transient disconnect timeout timer expires, it will pass the *current* status, but with the error from the original state change.
@AndyTWF AndyTWF force-pushed the connection-status-propagation branch from 0a90909 to 363742a Compare November 27, 2024 11:29
@AndyTWF AndyTWF merged commit bef2c15 into main Nov 27, 2024
9 checks passed
@AndyTWF AndyTWF deleted the connection-status-propagation branch November 27, 2024 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoaoDiasAbly JoaoDiasAbly JoaoDiasAbly approved these changes

@owenpearson owenpearson owenpearson approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AndyTWF @owenpearson @JoaoDiasAbly